<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="cloudlocationfinder_v1alpha.html">Cloud Location Finder API</a> . <a href="cloudlocationfinder_v1alpha.projects.html">projects</a> . <a href="cloudlocationfinder_v1alpha.projects.locations.html">locations</a> . <a href="cloudlocationfinder_v1alpha.projects.locations.cloudLocations.html">cloudLocations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a resource containing information about a cloud location.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists cloud locations under a given project and location.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#search">search(parent, pageSize=None, pageToken=None, query=None, sourceCloudLocation=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches for cloud locations from a given source location.</p>
<p class="toc_element">
  <code><a href="#search_next">search_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Retrieves a resource containing information about a cloud location.

Args:
  name: string, Required. Name of the resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents resource cloud locations.
  &quot;carbonFreeEnergyPercentage&quot;: 3.14, # Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers&#x27; application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.
  &quot;cloudLocationType&quot;: &quot;A String&quot;, # Optional. The type of the cloud location.
  &quot;cloudProvider&quot;: &quot;A String&quot;, # Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
  &quot;containingCloudLocation&quot;: &quot;A String&quot;, # Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
  &quot;territoryCode&quot;: &quot;A String&quot;, # Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists cloud locations under a given project and location.

Args:
  parent: string, Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location} (required)
  filter: string, Optional. A filter expression that filters resources listed in the response. The expression is in the form of field=value. For example, &#x27;cloud_location_type=CLOUD_LOCATION_TYPE_REGION&#x27;. Multiple filter queries are space-separated. For example, &#x27;cloud_location_type=CLOUD_LOCATION_TYPE_REGION territory_code=&quot;US&quot;&#x27; By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.
  pageSize: integer, Optional. The maximum number of cloud locations to return per page. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return. Provide page token returned by a previous &#x27;ListCloudLocations&#x27; call to retrieve the next page of results. When paginating, all other parameters provided to &#x27;ListCloudLocations&#x27; must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing cloud locations.
  &quot;cloudLocations&quot;: [ # Output only. List of cloud locations.
    { # Represents resource cloud locations.
      &quot;carbonFreeEnergyPercentage&quot;: 3.14, # Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers&#x27; application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.
      &quot;cloudLocationType&quot;: &quot;A String&quot;, # Optional. The type of the cloud location.
      &quot;cloudProvider&quot;: &quot;A String&quot;, # Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
      &quot;containingCloudLocation&quot;: &quot;A String&quot;, # Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
      &quot;displayName&quot;: &quot;A String&quot;, # Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
      &quot;territoryCode&quot;: &quot;A String&quot;, # Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="search">search(parent, pageSize=None, pageToken=None, query=None, sourceCloudLocation=None, x__xgafv=None)</code>
  <pre>Searches for cloud locations from a given source location.

Args:
  parent: string, Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location} (required)
  pageSize: integer, Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous &#x27;ListCloudLocations&#x27; call to retrieve the next page of results. When paginating, all other parameters provided to &#x27;ListCloudLocations&#x27; must match the call that provided the page token.
  query: string, Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements.
  sourceCloudLocation: string, Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to searching cloud locations.
  &quot;cloudLocations&quot;: [ # Output only. List of cloud locations.
    { # Represents resource cloud locations.
      &quot;carbonFreeEnergyPercentage&quot;: 3.14, # Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers&#x27; application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.
      &quot;cloudLocationType&quot;: &quot;A String&quot;, # Optional. The type of the cloud location.
      &quot;cloudProvider&quot;: &quot;A String&quot;, # Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
      &quot;containingCloudLocation&quot;: &quot;A String&quot;, # Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
      &quot;displayName&quot;: &quot;A String&quot;, # Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
      &quot;territoryCode&quot;: &quot;A String&quot;, # Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.
}</pre>
</div>

<div class="method">
    <code class="details" id="search_next">search_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>